<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- 
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License. 
-->
<html>
<head>
    <link type="text/css" rel="stylesheet" href="https://struts.apache.org/css/default.css">
    <style type="text/css">
        .dp-highlighter {
            width:95% !important;
        }
    </style>
    <style type="text/css">
        .footer {
            background-image:      url('https://cwiki.apache.org/confluence/images/border/border_bottom.gif');
            background-repeat:     repeat-x;
            background-position:   left top;
            padding-top:           4px;
            color:                 #666;
        }
    </style>
    <link href='https://struts.apache.org/highlighter/style/shCoreStruts.css' rel='stylesheet' type='text/css' />
    <link href='https://struts.apache.org/highlighter/style/shThemeStruts.css' rel='stylesheet' type='text/css' />
    <script src='https://struts.apache.org/highlighter/js/shCore.js' type='text/javascript'></script>
    <script src='https://struts.apache.org/highlighter/js/shBrushPlain.js' type='text/javascript'></script>
    <script src='https://struts.apache.org/highlighter/js/shBrushXml.js' type='text/javascript'></script>
    <script src='https://struts.apache.org/highlighter/js/shBrushJava.js' type='text/javascript'></script>
    <script src='https://struts.apache.org/highlighter/js/shBrushJScript.js' type='text/javascript'></script>
    <script src='https://struts.apache.org/highlighter/js/shBrushGroovy.js' type='text/javascript'></script>
    <script src='https://struts.apache.org/highlighter/js/shBrushBash.js' type='text/javascript'></script>
    <script type="text/javascript">
        SyntaxHighlighter.defaults['toolbar'] = false;
        SyntaxHighlighter.all();
    </script>
    <script type="text/javascript" language="javascript">
        var hide = null;
        var show = null;
        var children = null;

        function init() {
            /* Search form initialization */
            var form = document.forms['search'];
            if (form != null) {
                form.elements['domains'].value = location.hostname;
                form.elements['sitesearch'].value = location.hostname;
            }

            /* Children initialization */
            hide = document.getElementById('hide');
            show = document.getElementById('show');
            children = document.all != null ?
                    document.all['children'] :
                    document.getElementById('children');
            if (children != null) {
                children.style.display = 'none';
                show.style.display = 'inline';
                hide.style.display = 'none';
            }
        }

        function showChildren() {
            children.style.display = 'block';
            show.style.display = 'none';
            hide.style.display = 'inline';
        }

        function hideChildren() {
            children.style.display = 'none';
            show.style.display = 'inline';
            hide.style.display = 'none';
        }
    </script>
    <title>Simple Setup</title>
</head>
<body onload="init()">
<table border="0" cellpadding="2" cellspacing="0" width="100%">
    <tr class="topBar">
        <td align="left" valign="middle" class="topBarDiv" align="left" nowrap>
            &nbsp;<a href="home.html">Home</a>&nbsp;&gt;&nbsp;<a href="tutorials.html">Tutorials</a>&nbsp;&gt;&nbsp;<a href="bootstrap.html">Bootstrap</a>&nbsp;&gt;&nbsp;<a href="ready-set-go.html">Ready, Set, Go!</a>&nbsp;&gt;&nbsp;<a href="simple-setup.html">Simple Setup</a>
        </td>
        <td align="right" valign="middle" nowrap>
            <form name="search" action="https://www.google.com/search" method="get">
                <input type="hidden" name="ie" value="UTF-8" />
                <input type="hidden" name="oe" value="UTF-8" />
                <input type="hidden" name="domains" value="" />
                <input type="hidden" name="sitesearch" value="" />
                <input type="text" name="q" maxlength="255" value="" />
                <input type="submit" name="btnG" value="Google Search" />
            </form>
        </td>
    </tr>
</table>

<div id="PageContent">
    <div class="pageheader" style="padding: 6px 0px 0px 0px;">
        <!-- We'll enable this once we figure out how to access (and save) the logo resource -->
        <!--img src="/wiki/images/confluence_logo.gif" style="float: left; margin: 4px 4px 4px 10px;" border="0"-->
        <div style="margin: 0px 10px 0px 10px" class="smalltext">Apache Struts 2 Documentation</div>
        <div style="margin: 0px 10px 8px 10px"  class="pagetitle">Simple Setup</div>

        <div class="greynavbar" align="right" style="padding: 2px 10px; margin: 0px;">
            <a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=14183">
                <img src="https://cwiki.apache.org/confluence/images/icons/notep_16.gif"
                     height="16" width="16" border="0" align="absmiddle" title="Edit Page"></a>
            <a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=14183">Edit Page</a>
            &nbsp;
            <a href="https://cwiki.apache.org/confluence/pages/listpages.action?key=WW">
                <img src="https://cwiki.apache.org/confluence/images/icons/browse_space.gif"
                     height="16" width="16" border="0" align="absmiddle" title="Browse Space"></a>
            <a href="https://cwiki.apache.org/confluence/pages/listpages.action?key=WW">Browse Space</a>
            &nbsp;
            <a href="https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=WW&fromPageId=14183">
                <img src="https://cwiki.apache.org/confluence/images/icons/add_page_16.gif"
                     height="16" width="16" border="0" align="absmiddle" title="Add Page"></a>
            <a href="https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=WW&fromPageId=14183">Add Page</a>
            &nbsp;
            <a href="https://cwiki.apache.org/confluence/pages/createblogpost.action?spaceKey=WW&fromPageId=14183">
                <img src="https://cwiki.apache.org/confluence/images/icons/add_blogentry_16.gif"
                     height="16" width="16" border="0" align="absmiddle" title="Add News"></a>
            <a href="https://cwiki.apache.org/confluence/pages/createblogpost.action?spaceKey=WW&fromPageId=14183">Add News</a>
        </div>
    </div>

    <div class="pagecontent">
        <div class="wiki-content">
            <div id="ConfluenceContent"><p>If for some reason the blank template or archetype doesn't work out, we can just setup an application from scratch.</p>

<h2 id="SimpleSetup-SetuptheWebApplicationFileStructure">Setup the Web Application File Structure</h2>

<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
/tutorial/
/tutorial/META-INF/
/tutorial/WEB-INF/
/tutorial/WEB-INF/classes/struts.xml
/tutorial/WEB-INF/lib/
/tutorial/WEB-INF/lib/minimum JARs + any plugin JARs + plugin dependencies
/tutorial/WEB-INF/web.xml
</pre>
</div></div>
<ul><li>Copy to your <code>webapp/lib</code> directory
	<ul><li>the required JARs (see next section),</li><li>any Struts plugin JARs,</li><li>any plugin dependencies.</li></ul>
	</li></ul>


<div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>To customize the Struts templates (how HTML is rendered from the tags), copy into the application's <code>webapp</code> directory the framework's <code>/src/java/template</code> directory.</p></div></div>

<h2 id="SimpleSetup-InstalltheMinimumSetofLibrariesandConfigurationFiles">Install the Minimum Set of Libraries and Configuration Files</h2>

<p>The following files are a minium requirement for your application.</p>
<div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Filename </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>struts2-core.jar</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Framework library itself, found in distribution root directory </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>xwork.jar</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> XWork 2 library on which Struts 2 is built (version 2.0 or later) </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>ognl.jar</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Object Graph Navigation Language (OGNL), the expression language used throughout the framework </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>javassist.jar</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Java bytecode manipulation library used by OGNL </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>freemarker.jar</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> All UI tag templates are written in Freemarker (also a good option for your own views) </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>commons-logging.jar</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Commons logging, which the framework uses to support transparently logging to either Log4J or JDK 1.4+ </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>commons-fileupload.jar</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The Commons FileUpload package makes it easy to add robust, high-performance, file upload capability to your servlets and web applications. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>commons-io.jar</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Commons IO is a library of utilities to assist with developing IO functionality. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>commons-lang3.jar</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Commons Lang3 is used to simplify usage of common tasks and code shortcuts to to stay DRY </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>web.xml</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Java web application configuration file that defines the filters (and other components) for your web application </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>struts.xml</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Framework configuration file that defines the actions, results, and interceptors for your application </p></td></tr></tbody></table></div>


<p>If any Struts 2 Plugins are included, then other JARs may be needed too. For example, the optional Spring Plugin requires the Spring JARs to be present.</p>

<h2 id="SimpleSetup-SetuptheWebApplicationDeploymentDescriptor(web.xml)">Setup the Web Application Deployment Descriptor (<code>web.xml</code>)</h2>

<p>Create an <code>web.xml</code> file in <code>[webapp]/WEB-INF</code> (or merge into it the framework resources).</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>web.xml</b></div><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
&lt;?xml version="1.0"?&gt;
&lt;!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd"&gt;

&lt;web-app&gt;
  &lt;display-name&gt;My Application&lt;/display-name&gt;
  &lt;filter&gt;
    &lt;filter-name&gt;struts2&lt;/filter-name&gt;
    &lt;filter-class&gt;org.apache.struts2.dispatcher.ng.filter.StrutsExecuteFilter&lt;/filter-class&gt;
  &lt;/filter&gt;

  &lt;filter-mapping&gt;
    &lt;filter-name&gt;struts2&lt;/filter-name&gt;
    &lt;url-pattern&gt;/*&lt;/url-pattern&gt;
  &lt;/filter-mapping&gt;
&lt;/web-app&gt;

</pre>
</div></div>
<p>The standard <code>web.xml</code> registers a FilterDispatcher to enable framework functionality for your requests. </p>

<p>If other packages are being used, like SiteMesh or Spring, then other filters may need to be configured too </p>

<p><img class="emoticon emoticon-light-on" src="https://cwiki.apache.org/confluence/s/en_GB/5982/f2b47fb3d636c8bc9fd0b11c0ec6d0ae18646be7.1/_/images/icons/emoticons/lightbulb_on.png" data-emoticon-name="light-on" alt="(lightbulb)"> See also: <a shape="rect" href="webxml.html">web.xml</a></p>

<h2 id="SimpleSetup-SetuptheStrutsConfiguration(struts.xml)">Setup the Struts Configuration (<code>struts.xml</code>)</h2>

<p>Create a skeleton <code>struts.xml</code> file in <code>/$APP/WEB-INF/classes</code>.</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>struts.xml</b></div><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
&lt;!DOCTYPE struts PUBLIC
    "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
    "http://struts.apache.org/dtds/struts-2.0.dtd"&gt;

&lt;struts&gt;&lt;!-- Configuration for the default package. --&gt;
	&lt;package name="default" extends="struts-default"&gt;
         ...
	&lt;/package&gt;
&lt;/struts&gt;
</pre>
</div></div>
<p>For now, the <code>struts.xml</code> just defines a default package (with the &lt;package&gt; section) where framework elements like <code>actions</code>, <code>results</code> and <code>interceptors</code> are registered.</p>

<p><img class="emoticon emoticon-light-on" src="https://cwiki.apache.org/confluence/s/en_GB/5982/f2b47fb3d636c8bc9fd0b11c0ec6d0ae18646be7.1/_/images/icons/emoticons/lightbulb_on.png" data-emoticon-name="light-on" alt="(lightbulb)"> See also: <a shape="rect" href="strutsxml.html">struts.xml</a></p>

<div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Next </p></th><td colspan="1" rowspan="1" class="confluenceTd"><p> Onward to <a shape="rect" href="hello-world.html">Hello World</a> </p></td></tr><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Prev </p></th><td colspan="1" rowspan="1" class="confluenceTd"><p> Return to <a shape="rect" href="ready-set-go.html">Ready, Set, Go!</a> </p></td></tr></tbody></table></div></div>
        </div>

        
    </div>
</div>
<div class="footer">
    Generated by CXF SiteExporter
</div>
</body>
</html>
